BlueSpray - Help
© SchoonerTurtles, Inc. 2012-2015
Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About

Class STTiler

Extends STTransformRaster

Enumerated Types

TILE_PURPOSE
    ANALYSIS - Keep the original data
    VIEWING - Convert the data to 8-bit and stretch it

Static Functions

ReturnsFunctionThrows
int[][] CalculateTilePositions(
     double RefTileWidth,double RefTileHeight,boolean ReferenceToSRS,STBounds TheBounds)		  
int GetZoomLevelFromResolution(double Resolution)  

Object Functions

ReturnsFunctionThrows
  STTiler() Exception
SetHighestResPixelWidthInMapUnits(double New)  
SetHighestResZoomLevel(int NewHighestResZoomLevel)  
SetIgnoreEmptyTiles(boolean New)  
SetMode(TILE_PURPOSE New)  
SetNumLevels(int New)  
SetTileHeightInPixels(int NewTileHeightInPixels)  
SetTileRelativeToReferenceSystem(boolean New)  
SetTileWidthInPixels(int NewTileWidthInPixels)  
TileRaster(STRaster TheInput,STBounds TheRefBounds,String FilePath) Exception

Static Functions

int[][] CalculateTilePositions(
     double RefTileWidth,double RefTileHeight,boolean ReferenceToSRS,STBounds TheBounds)  

Computes the positions of the tile that will be generated within a grid
of rows and columns for the reference area.

Parameters:
    RefTileWidth - positive width
    RefTileHeight - negative height
    ReferenceToSRS - true to reference the tiles from the origin of the coordinate system, false to reference from the upper left corner of the bounds
    TheBounds - area for the rows and columns in map units
Returns:

int GetZoomLevelFromResolution(double Resolution)  

Function to complete the zoom level from a resolution

Parameters:
    Resolution - map units per pixel (e.g. meters per pixel, degrees per pixel)
Returns: - the zoom level where:

Object Functions

  STTiler() Exception

SetHighestResPixelWidthInMapUnits(double New)  

Set the resolution, in ref units, for the highest (most detailed or
bottom step) resolution step of the pyramid.

Parameters:
    HighestResPixelWidthInMapUnits -

SetHighestResZoomLevel(int NewHighestResZoomLevel)  

Set the number of the highest resolution zoom level step in the pyramid.

Parameters:
    New -

SetIgnoreEmptyTiles(boolean New)  

Setting this to true will keep the tiler from saving files that are empty (i.e. no data)

Parameters:
    New -

SetMode(TILE_PURPOSE New)  

Set the mode for how the tiles will be created.
Note: This is not yet supported.

Parameters:
    New -

SetNumLevels(int New)  

Set the number of levels in the pyramid.

Parameters:
    New -

SetTileHeightInPixels(int NewTileHeightInPixels)  

The height of the tiles in pixels, the default is 256.

Parameters:
    TileHeightInPixels -

SetTileRelativeToReferenceSystem(boolean New)  

Set whether to consider the bounds as reference bounds or pixel bounds within the raster.

Parameters:
    TileRelativeToReferenceSystem -

SetTileWidthInPixels(int NewTileWidthInPixels)  

The width of the tiles in pixels, the default is 256.

Parameters:
    TileWidthInPixels -

TileRaster(STRaster TheInput,STBounds TheRefBounds,String FilePath) Exception

Create a pyramid of tiles from a raster.

Parameters:
    TheInput - the raster layer to be tiled
    TheLayerBounds - the reference bounds to be tiled. null to use the layer's bounds
    FilePath - a full file path, including file extension, for the files to be generated.